Module: server/trpc

Type Aliases

CreateContextOptions

Ƭ CreateContextOptions: Object

Options of createInnerTRPCContext.

Type declaration

Name	Type
session	Session | null

Defined in

src/web-app/src/server/trpc.ts:11

Variables

protectedProcedure

• Const protectedProcedure: CreateProcedureReturnInput<, >

Protected (authenticated) procedure.

If you want a query or mutation to ONLY be accessible to logged in users, use this. It verifies the session is valid and guarantees ctx.session.user is not null.

See

https://trpc.io/docs/procedures

Defined in

src/web-app/src/server/trpc.ts:86

---

publicProcedure

• Const publicProcedure: ProcedureBuilder<> = t.procedure

Defined in

src/web-app/src/server/trpc.ts:64

Functions

createInnerTRPCContext

▸ createInnerTRPCContext(opts): Object

This helper generates the "internals" for a tRPC context. If you need to use it, you can export it from here.

Examples of things you may need it for:

• testing, so we don't have to mock Next.js' req/res
• tRPC's createSSGHelpers, where we don't have req/res.

Parameters

Name	Type	Description
opts	CreateContextOptions	Options for the context.

Returns

Object

The internals of a tRPC context object.

Name	Type
prisma	PrismaClient<PrismaClientOptions, never, undefined | RejectOnNotFound | RejectPerOperation, DefaultArgs>
session	null | Session

See

https://create.t3.gg/en/usage/trpc#-serverapitrpcts

Defined in

src/web-app/src/server/trpc.ts:26

---

createTRPCContext

▸ createTRPCContext(opts): Promise<{ prisma: PrismaClient<PrismaClientOptions, never, undefined | RejectOnNotFound | RejectPerOperation, DefaultArgs> ; session: null | Session = opts.session }>

This is the actual context you will use in your router. It will be used to process every request that goes through your tRPC endpoint.

Parameters

Name	Type	Description
opts	CreateNextContextOptions	Options for the context.

Returns

Promise<{ prisma: PrismaClient<PrismaClientOptions, never, undefined | RejectOnNotFound | RejectPerOperation, DefaultArgs> ; session: null | Session = opts.session }>

A tRPC context.

See

https://trpc.io/docs/context

Defined in

src/web-app/src/server/trpc.ts:40

---

createTRPCRouter

▸ createTRPCRouter<TProcRouterRecord>(procedures): CreateRouterInner<RootConfig<>, TProcRouterRecord>

This is how you create new routers and sub-routers in your tRPC API.

Type parameters

Name	Type
TProcRouterRecord	extends ProcedureRouterRecord

Parameters

Name	Type
procedures	TProcRouterRecord

Returns

CreateRouterInner<RootConfig<>, TProcRouterRecord>

See

https://trpc.io/docs/router

Defined in

src/web-app/src/server/trpc.ts:63